Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Signed-off-by: Aviv Keller <[email protected]>
There was a problem hiding this comment.
Pull request overview
Adds a new Node-API (N-API) documentation section to the Learn site, including sidebar navigation and a set of rewritten guides ported from node-addon-examples.
Changes:
- Add a new “Node-API” group to
site.jsonsidebar navigation. - Add new Node-API docs pages (overview, getting started, build tools, special topics).
- Update Sidebar pathname handling to better support
index.md-based routes.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 32 comments.
Show a summary per file
| File | Description |
|---|---|
| site.json | Adds “Node-API” section + links to the Learn sidebar |
| components/Sidebar/index.jsx | Adjusts pathname handling to strip /index |
| pages/napi/index.md | Introduces Node-API landing page content |
| pages/napi/getting-started/index.md | Adds Getting Started index page |
| pages/napi/getting-started/prerequisites.md | Adds prerequisites content |
| pages/napi/getting-started/tools.md | Adds tooling/setup guidance |
| pages/napi/getting-started/project-structure.md | Adds shared project structure reference |
| pages/napi/getting-started/your-first-project.md | Adds first-project tutorial |
| pages/napi/getting-started/objectwrap.md | Adds ObjectWrap tutorial |
| pages/napi/getting-started/migration.md | Adds NAN → Node-API migration tutorial |
| pages/napi/build-tools/index.md | Adds build-tools index page |
| pages/napi/build-tools/node-gyp.md | Adds node-gyp guide |
| pages/napi/build-tools/cmake-js.md | Adds CMake.js guide |
| pages/napi/build-tools/node-pre-gyp.md | Adds node-pre-gyp guide |
| pages/napi/build-tools/prebuild.md | Adds prebuild guide |
| pages/napi/special-topics/index.md | Adds special-topics index page |
| pages/napi/special-topics/asyncworker.md | Adds AsyncWorker guide |
| pages/napi/special-topics/object-function-refs.md | Adds references guide |
| pages/napi/special-topics/thread-safe-functions.md | Adds thread-safe functions guide |
| pages/napi/special-topics/context-awareness.md | Adds context-awareness guide + examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]> Co-authored-by: Aviv Keller <[email protected]> Signed-off-by: Aviv Keller <[email protected]>
|
Bump @nodejs/node-api @nodejs/nodejs-website |
PR SummaryLow Risk Overview Updates Reviewed by Cursor Bugbot for commit de1e72d. Bugbot is set up for automated code reviews on this repo. Configure here. |
|
We want to avoid the term 'napi' to use in future. Is it possible to name the folder 'node-api'? |
I think we should prefer |
cc @nodejs/node-api
I've re-written these files from https://github.com/nodejs/node-addon-examples/tree/main/website/docs. Please note that these files are not identical to the previous versions. I've made some minor adjustments, including, but not limited to:
pages/napi/getting-started/project-structure.md, and addingindex.mdpagesThe authors of these files are currently marked as @gabrielschulhof, @NickNaso, @jschlight, @mhdawson, @KevinEady, and myself, @avivkeller.